feat(API): use tree endpoint to build TOC, use page ID's over paths

LibreTexts · May 12, 2024 · 4598503 · 4598503
1 parent 10321d9
commit 4598503
Show file tree

Hide file tree

Showing 3 changed files with 83 additions and 11 deletions.
diff --git a/API/endpoint.js b/API/endpoint.js
@@ -255,18 +255,17 @@ async function handler(request, response) {
         }
     } else if (url.startsWith('/getTOC/')) {
         if (request.method === 'GET') {
-            let start = performance.now();
-            response.writeHead(200, {'Content-Type': 'application/json'});
-            let resourceURL = url.split('/getTOC/')[1];
-            resourceURL.replace('%3A', ':');
-            let pages = await LibreTexts.getSubpages(resourceURL, 'LibreBot', { flat: false });
-            let end = performance.now();
+            const start = performance.now();
+            response.writeHead(200, { 'Content-Type': 'application/json' });
+            const resourceURL = url.split('/getTOC/')[1];
+            const toc = await LibreTexts.getTOC(resourceURL, 'LibreBot');
+            const end = performance.now();
             response.end(JSON.stringify({
                 time: `${end - start} ms`,
-                toc: pages
+                toc,
             }));
         } else {
-            responseError(request.method + 'Not Acceptable', 406);
+            responseError(`${request.method} Not Acceptable`, 406);
         }
     } else if (url.startsWith('/licensereport/')) {
         let [, root] = url.split('/licensereport/');

diff --git a/API/reuse.js b/API/reuse.js
@@ -36,6 +36,7 @@ let LibreTextsFunctions = {
     parseURL: parseURL,
     cleanPath: cleanPath,
     getAPI: getAPI,
+    getTOC: getTOC,
     getUser: getUser,
     addProperty: addProperty,
     sleep: sleep,
@@ -924,6 +925,78 @@ async function getAPI(page, getContents, username = undefined) {
     return page;
 }
 
+/**
+ * Builds a Table of Contents for a book/text.
+ *
+ * The TOC in flat and hierarchical form, or null if error encountered.
+ */
+async function getTOC(rootURL, username) {
+    const coverpageData = await getAPI(rootURL, false, username);
+
+    async function getRawTOC(page) {
+        let res = await authenticatedFetch(
+            page.id,
+            'tree?dream.out.format=json&include=properties,lastmodified',
+            page.subdomain,
+            username,
+        );
+        res = await res.json();
+        return res?.page ?? null;
+    }
+
+    function buildHierarchy(page, parentID) {
+        const pageID = Number.parseInt(page['@id'], 10);
+        const subpages = [];
+
+        const processPage = (p) => ({
+            ...p,
+            id: pageID,
+            subdomain: extractSubdomain(p['uri.ui']),
+            url: p['uri.ui'],
+        });
+
+        if (Array.isArray(page?.subpages?.page)) {
+            page.subpages.page.forEach((p) => subpages.push(buildHierarchy(p, pageID)));
+        } else if (typeof page?.subpages?.page === 'object') {
+            // single page
+            subpages.push(buildHierarchy(page.subpages.page, pageID));
+        }
+
+        return processPage({
+            ...page,
+            ...(parentID && { parentID }),
+            ...(subpages.length && { subpages }),
+        });
+    }
+
+    /**
+     * Recursively flattens a page hierachy by extracting any subpages and removing
+     * their container array.
+     *
+     * @param {Object} page - Page at the level of the hierarchy to start flattening at.
+     * @returns {Object[]} The flattened array of page objects.
+     */
+    function flatHierarchy(page) {
+        let pagesArr = [];
+        const pageData = { ...page };
+        if (Array.isArray(pageData.subpages)) {
+            pageData.subpages.forEach((subpage) => {
+                pagesArr = [...pagesArr, ...flatHierarchy(subpage)];
+            });
+        }
+        delete pageData.subpages;
+        pagesArr.unshift(pageData); // add to front to preserve "ordering"
+        return pagesArr;
+    }
+
+    const rawTOC = await getRawTOC(coverpageData);
+    if (!rawTOC) return null;
+    const structured = buildHierarchy(rawTOC);
+    const flat = flatHierarchy(structured);
+
+    return { structured, flat };
+}
+
 /**
  * Get the information for a particular user
  * @param {string} username - user to get information about

diff --git a/public/Miscellaneous/reuse.js b/public/Miscellaneous/reuse.js
@@ -585,7 +585,7 @@ function LibreTextsReuse() {
 
       async function getRawTOC(page) {
         let res = await authenticatedFetch(
-          page.path,
+          page.id,
           'tree?dream.out.format=json&include=properties,lastmodified',
           page.subdomain,
         );
@@ -594,8 +594,8 @@ function LibreTextsReuse() {
       }
 
       function buildHierarchy(page, parentID) {
-        const pageID = Number.parseInt(page['@id']);
-        let subpages = [];
+        const pageID = Number.parseInt(page['@id'], 10);
+        const subpages = [];
 
         const processPage = (p) => ({
           ...p,